Cleanup some docs (includes/*.php)

[lhc/web/wiklou.git] / includes / StubObject.php

diff --git a/includes/StubObject.php b/includes/StubObject.php
index 64df81b..73952da 100644 (file)
--- a/includes/StubObject.php
+++ b/includes/StubObject.php
@@ -43,13 +43,13 @@
  */
 class StubObject {
        /** @var null|string */
-       protected $mGlobal;
+       protected $global;
 
        /** @var null|string */
-       protected $mClass;
+       protected $class;
 
        /** @var array */
-       protected $mParams;
+       protected $params;
 
        /**
         * Constructor.
@@ -59,9 +59,9 @@ class StubObject {
         * @param array $params Parameters to pass to constructor of the real object.
         */
        function __construct( $global = null, $class = null, $params = array() ) {
-               $this->mGlobal = $global;
-               $this->mClass = $class;
-               $this->mParams = $params;
+               $this->global = $global;
+               $this->class = $class;
+               $this->params = $params;
        }
 
        /**
@@ -83,9 +83,9 @@ class StubObject {
         * @param object $obj Object to check.
         * @return void
         */
-       static function unstub( $obj ) {
+       static function unstub( &$obj ) {
                if ( $obj instanceof StubObject ) {
-                       $obj->_unstub( 'unstub', 3 );
+                       $obj = $obj->_unstub( 'unstub', 3 );
                }
        }
 
@@ -102,7 +102,7 @@ class StubObject {
         */
        function _call( $name, $args ) {
                $this->_unstub( $name, 5 );
-               return call_user_func_array( array( $GLOBALS[$this->mGlobal], $name ), $args );
+               return call_user_func_array( array( $GLOBALS[$this->global], $name ), $args );
        }
 
        /**
@@ -110,7 +110,7 @@ class StubObject {
         * @return object
         */
        function _newObject() {
-               return MWFunction::newObj( $this->mClass, $this->mParams );
+               return MWFunction::newObj( $this->class, $this->params );
        }
 
        /**
@@ -134,62 +134,35 @@ class StubObject {
         * @param string $name Name of the method called in this object.
         * @param int $level Level to go in the stack trace to get the function
         *   who called this function.
+        * @return object The unstubbed version of itself
         * @throws MWException
         */
        function _unstub( $name = '_unstub', $level = 2 ) {
                static $recursionLevel = 0;
 
-               if ( !$GLOBALS[$this->mGlobal] instanceof StubObject ) {
-                       return $GLOBALS[$this->mGlobal]; // already unstubbed.
+               if ( !$GLOBALS[$this->global] instanceof StubObject ) {
+                       return $GLOBALS[$this->global]; // already unstubbed.
                }
 
-               if ( get_class( $GLOBALS[$this->mGlobal] ) != $this->mClass ) {
-                       $fname = __METHOD__ . '-' . $this->mGlobal;
+               if ( get_class( $GLOBALS[$this->global] ) != $this->class ) {
+                       $fname = __METHOD__ . '-' . $this->global;
                        wfProfileIn( $fname );
                        $caller = wfGetCaller( $level );
                        if ( ++$recursionLevel > 2 ) {
                                wfProfileOut( $fname );
                                throw new MWException( "Unstub loop detected on call of "
-                                       . "\${$this->mGlobal}->$name from $caller\n" );
+                                       . "\${$this->global}->$name from $caller\n" );
                        }
-                       wfDebug( "Unstubbing \${$this->mGlobal} on call of "
-                               . "\${$this->mGlobal}::$name from $caller\n" );
-                       $GLOBALS[$this->mGlobal] = $this->_newObject();
+                       wfDebug( "Unstubbing \${$this->global} on call of "
+                               . "\${$this->global}::$name from $caller\n" );
+                       $GLOBALS[$this->global] = $this->_newObject();
                        --$recursionLevel;
                        wfProfileOut( $fname );
+                       return $GLOBALS[$this->global];
                }
        }
 }
 
-/**
- * Stub object for the content language of this wiki. This object have to be in
- * $wgContLang global.
- *
- * @deprecated since 1.18
- */
-class StubContLang extends StubObject {
-
-       function __construct() {
-               wfDeprecated( __CLASS__, '1.18' );
-               parent::__construct( 'wgContLang' );
-       }
-
-       function __call( $name, $args ) {
-               return $this->_call( $name, $args );
-       }
-
-       /**
-        * @return Language
-        */
-       function _newObject() {
-               global $wgLanguageCode;
-               $obj = Language::factory( $wgLanguageCode );
-               $obj->initEncoding();
-               $obj->initContLang();
-               return $obj;
-       }
-}
-
 /**
  * Stub object for the user language. It depends of the user preferences and
  * "uselang" parameter that can be passed to index.php. This object have to be